<FILE>gtkprogressbar</FILE>
<TITLE>GtkProgressBar</TITLE>
GtkProgressBar
-GtkProgressBarStyle
-GtkProgressBarOrientation
gtk_progress_bar_new
gtk_progress_bar_pulse
gtk_progress_bar_set_text
gtk_progress_bar_set_fraction
gtk_progress_bar_set_pulse_step
+gtk_progress_bar_set_orientation
+GtkProgressBarOrientation
+gtk_progress_bar_get_text
gtk_progress_bar_get_fraction
gtk_progress_bar_get_pulse_step
-gtk_progress_bar_get_text
+gtk_progress_bar_get_orientation
gtk_progress_bar_new_with_adjustment
gtk_progress_bar_set_bar_style
+GtkProgressBarStyle
gtk_progress_bar_set_discrete_blocks
gtk_progress_bar_set_activity_step
gtk_progress_bar_set_activity_blocks
-gtk_progress_bar_set_orientation
-gtk_progress_bar_get_orientation
gtk_progress_bar_update
<SUBSECTION Standard>
GTK_PROGRESS_BAR
progress, it can use the #GtkProgressBar in percentage mode and the user
sees a growing bar indicating the percentage of the work that has
been completed. In this mode, the application is required to call
-either the gtk_progress_set_percentage() or gtk_progress_set_value()
-functions periodically to update the progress bar.
+gtk_progress_bar_set_fraction() periodically to update the progress bar.
</para>
<para>
When an application has no accurate way of knowing the amount of work
-to do, it can use the #GtkProgressBar in activity mode. In this mode
-the progress bar shows activity by a block moving back and forth within
-the progress area.
+to do, it can use the #GtkProgressBar in activity mode, which shows activity
+by a block moving back and forth within the progress area. In this mode,
+the application is required to call gtk_progress_bar_pulse() perodically
+to update the progress bar.
</para>
<para>
There is quite a bit of flexibility provided to control the appearance
of the #GtkProgressBar. Functions are provided to control the
-orientation of the bar, optional text which can be displayed along with
-the bar, and the style in which the bar grows.
+orientation of the bar, optional text can be displayed along with
+the bar, and the step size used in activity mode can be set.
</para>
+<note>
+<para>
+The #GtkProgressBar/#GtkProgress API in GTK 1.2 was bloated, needlessly complex
+and hard to use properly. Therefore #GtkProgress has been deprecated
+completely and the #GtkProgressBar API has been reduced to the following 9
+functions: gtk_progress_bar_new(), gtk_progress_bar_pulse(), gtk_progress_bar_set_text(),
+gtk_progress_bar_set_fraction(), gtk_progress_bar_set_pulse_step(),
+gtk_progress_bar_set_orientation(), gtk_progress_bar_get_text(),
+gtk_progress_bar_get_fraction(), gtk_progress_bar_get_pulse_step(). These have
+been grouped at the beginning of this section, followed by a large chunk of
+deprecated 1.2 compatibility functions.
+</para>
+</note>
+
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-<!-- ##### ENUM GtkProgressBarStyle ##### -->
+<!-- ##### FUNCTION gtk_progress_bar_new ##### -->
<para>
-An enumeration representing the styles for drawing the progress bar.
+Creates a new #GtkProgressBar.
+</para>
-<informaltable pgwide=1 frame="none" role="enum">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
+@Returns: a #GtkProgressBar.
-<row>
-<entry>GTK_PROGRESS_CONTINUOUS</entry>
-<entry>The progress bar grows in a smooth, continuous manner.</entry>
-</row>
-<row>
-<entry>GTK_PROGRESS_DISCRETE</entry>
-<entry>The progress bar grows in discrete, visible blocks.</entry>
-</row>
+<!-- ##### FUNCTION gtk_progress_bar_pulse ##### -->
+<para>
-</tbody></tgroup></informaltable>
</para>
-@GTK_PROGRESS_CONTINUOUS:
-@GTK_PROGRESS_DISCRETE:
+@pbar:
+
+
+<!-- ##### FUNCTION gtk_progress_bar_set_text ##### -->
+<para>
+
+</para>
+
+@pbar:
+@text:
+
+
+<!-- ##### FUNCTION gtk_progress_bar_set_fraction ##### -->
+<para>
+
+</para>
+
+@pbar:
+@fraction:
+
+
+<!-- ##### FUNCTION gtk_progress_bar_set_pulse_step ##### -->
+<para>
+
+</para>
+
+@pbar:
+@fraction:
+
+
+<!-- ##### FUNCTION gtk_progress_bar_set_orientation ##### -->
+<para>
+
+</para>
+
+@pbar:
+@orientation:
+
<!-- ##### ENUM GtkProgressBarOrientation ##### -->
<para>
@GTK_PROGRESS_BOTTOM_TO_TOP:
@GTK_PROGRESS_TOP_TO_BOTTOM:
-<!-- ##### FUNCTION gtk_progress_bar_new ##### -->
-<para>
-Creates a new #GtkProgressBar.
-</para>
-
-@Returns: a #GtkProgressBar.
-
-
-<!-- ##### FUNCTION gtk_progress_bar_pulse ##### -->
-<para>
-
-</para>
-
-@pbar:
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_text ##### -->
-<para>
-
-</para>
-
-@pbar:
-@text:
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_fraction ##### -->
-<para>
-
-</para>
-
-@pbar:
-@fraction:
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_pulse_step ##### -->
+<!-- ##### FUNCTION gtk_progress_bar_get_text ##### -->
<para>
</para>
@pbar:
-@fraction:
+@Returns:
<!-- ##### FUNCTION gtk_progress_bar_get_fraction ##### -->
@Returns:
-<!-- ##### FUNCTION gtk_progress_bar_get_text ##### -->
+<!-- ##### FUNCTION gtk_progress_bar_get_orientation ##### -->
<para>
</para>
@style: a #GtkProgressBarStyle value indicating the desired style.
+<!-- ##### ENUM GtkProgressBarStyle ##### -->
+<para>
+An enumeration representing the styles for drawing the progress bar.
+
+<informaltable pgwide=1 frame="none" role="enum">
+<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
+<tbody>
+
+<row>
+<entry>GTK_PROGRESS_CONTINUOUS</entry>
+<entry>The progress bar grows in a smooth, continuous manner.</entry>
+</row>
+
+<row>
+<entry>GTK_PROGRESS_DISCRETE</entry>
+<entry>The progress bar grows in discrete, visible blocks.</entry>
+</row>
+
+</tbody></tgroup></informaltable>
+</para>
+
+@GTK_PROGRESS_CONTINUOUS:
+@GTK_PROGRESS_DISCRETE:
+
<!-- ##### FUNCTION gtk_progress_bar_set_discrete_blocks ##### -->
<para>
Sets the number of blocks that the progress bar is divided into
@blocks: number of blocks which can fit within the progress bar area.
-<!-- ##### FUNCTION gtk_progress_bar_set_orientation ##### -->
-<para>
-
-</para>
-
-@pbar:
-@orientation:
-
-
-<!-- ##### FUNCTION gtk_progress_bar_get_orientation ##### -->
-<para>
-
-</para>
-
-@pbar:
-@Returns:
-
-
<!-- ##### FUNCTION gtk_progress_bar_update ##### -->
<para>
This function is deprecated. Please use gtk_progress_set_value() or
<book id="gtk-tut">
<bookinfo>
- <date>February 20, 2002</date>
+ <date>February 25, 2002</date>
<title>GTK+ 2.0 Tutorial</title>
<authorgroup>
<author>
<para>You can compile the above program with gcc using:</para>
<para><literallayout>
-<literal>gcc base.c -o base `pkg-config --cflags --libs gtk-2.0`</literal>
+<literal>gcc base.c -o base `pkg-config --cflags --libs gtk+-2.0`</literal>
</literallayout></para>
<para>The meaning of the unusual compilation options is explained below in
<para>To compile use:</para>
<para><literallayout>
-<literal>gcc -Wall -g helloworld.c -o helloworld `pkg-config --cflags gtk-2.0` \</literal>
-<literal> `pkg-config --libs gtk-2.0`</literal>
+<literal>gcc -Wall -g helloworld.c -o helloworld `pkg-config --cflags gtk+-2.0` \</literal>
+<literal> `pkg-config --libs gtk+-2.0`</literal>
</literallayout></para>
<para>This uses the program <literal>pkg-config</literal>, which can be obtained from
<para>If you don't like to poke directly at struct internals like a
<emphasis>real</emphasis> C programmer, you can use the following accessor to
-inspect the <literal>value</literal> of an adjustment:
+inspect the <literal>value</literal> of an adjustment:</para>
<programlisting role="C">
gdouble gtk_adjustment_get_value( GtkAdjustment *adjustment);
projects / gtk4.git / commitdiff